/**
 * MIT License
 * 
 * Copyright (c) 2024 - present @ ebraid
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#ifndef __EB_IRQ_H__
#define __EB_IRQ_H__


#include <types.h>
#include <irqnum.h>


#define IRQF_RISING     (0x0001)
#define IRQF_FALLING    (0x0002)
#define IRQF_EDGE       (IRQF_RISING | IRQF_FALLING)
#define IRQF_HIGH       (0x0004)
#define IRQF_LOW        (0x0008)
#define IRQF_LEVEL      (IRQF_HIGH | IRQF_LOW)


typedef void (*irq_handler_t)(void *data);


/**
 * @brief request an interrupt handler
 * @param irq interrupt number
 * @param handler interrupt handler
 * @param data data to pass to the handler
 * @return 0 on success, -1 on failure
 */
int irq_request(uint32_t irq, void (*handler)(void *data), void *data);


/**
 * @brief free an interrupt handler
 * @param irq interrupt number
 * @return none
 */
void irq_free(uint32_t irq);


/**
 * @brief enable an interrupt
 * @param irq interrupt number
 * @return none
 */
void irq_enable(uint32_t irq);


/**
 * @brief disable an interrupt
 * @param irq interrupt number
 * @return none
 */
void irq_disable(uint32_t irq);


/**
 * @brief clear an interrupt flag
 * @param arg interrupt flag
 * @return none
 */
void irq_clear_flag(unsigned long arg);


#endif //!__EB_IRQ_H__
